/*
 * Copyright 2009-2010 the original author or authors.
 *
 * Licensed under the Apache license, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.internna.iwebjtracker.sonar.services;

import org.internna.iwebmvc.model.UUID;

/**
 * Persists Sonar configuration for a given project.
 *
 * @author Jose Noheda
 * @since 1.0
 */
public interface SonarConfigurator {

    /**
     * Error i18n key when Maven's groupId or artifactId are missing.
     */
    String SONAR_MISSING_MAVEN_INFO = "sonar.error.nomaven";

    /**
     * Error i18n key when the configured server does not answer the request.
     */
    String SONAR_NO_RESPONSE_FROM_SERVER = "sonar.error.noresponse";

    /**
     * Saves a Sonar Configuration object.
     *
     * @param project any (if null no operation is performed)
     * @param groupId any (if null no operation is performed)
     * @param artifactId any (if null no operation is performed)
     * @param details any (if null no operation is performed)
     * @return the i18n translated Error
     */
    String configure(UUID project, String groupId, String artifactId, UUID connectionDetails);

}
